home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / pcboard / k_read40.zip / K-READ.DOC < prev    next >
Text File  |  1996-02-15  |  11KB  |  217 lines
  1.  
  2. ■ GENERAL DESCRIPTION
  3. ---------------------
  4.  
  5. In my experience with PCBoard, it seems that only PCBoard sysops know
  6. how to effectively read messages.  Most people press 'r' then they get
  7. that little crappy prompt, hit 'h/?' for help, see how long the help
  8. file is and quit the help file.  They then decide it's too much work to
  9. read messages, so they hit 'q' thinking that will quit the message read
  10. prompt, but then realize that doesn't work.
  11.  
  12. Anyway!  I've seen a lot of decent message read replacements, but none
  13. that do quite want I want.  Whitewater Technologies' RPROMPT by far one
  14. of the better RPROMPT replacements, but it's not for the 'R' command.
  15. (I strongly urge you install RPROMPT if you already haven't -- it's
  16. free, and THE best 'End of Message command' replacement I've seen to
  17. date and it's the perfect compliment to K-READ).
  18.  
  19. So then I actually found a freeware (I don't bother with shareware PPEs)
  20. 'r' replacement.  But it either wasn't configurable, or was meant to be
  21. configurable but didn't work if you tried to change its looks ;).  Since
  22. my board is heavily customized, I have to be able to change a PPE
  23. aesthetically if I am to use it.  That one got the boot.
  24.  
  25. Finally, I did find another 'r' replacement, and I did like everything
  26. about it, but it just didn't have all the commands I wanted for message
  27. reading; it seemed to leave a few important message functions out.
  28. (I'll admit: if you wanted to have EVERY possible message function,
  29. you'd have a list that'd be quite long.  PCB's message system does
  30. EVERYTHING).
  31.  
  32. So, for a while I was just using a PCB .MNU file (pretty much the
  33. 'k-rmnu' that's included with this package).  This worked great for a
  34. while, but I have to have lightbar options ;).  So thus I produced the
  35. result you see today.
  36.  
  37. Give it a try right now!  If pcboard?.exe is in your path (which it
  38. REALLY should be), type 'Pcboard /ppe:k-read' (minus quotes) and take it
  39. for a test drive.  I think you'll be pleasantly suprized.
  40.  
  41.  
  42. ■ DISCLAIMER
  43. ------------
  44.  
  45. This software is provided "as is."  I make no warrantees or guarantees as
  46. to this PPEs operation.  I, the author of this product, am not in ANY way
  47. responsible for these files.  You, the user, take FULL responsibility for
  48. this product.  I am NOT liable for any accidents or mishaps.  YOUR computer
  49. is YOUR responsibility.  This product works okay for me -- it may not for
  50. you! ALWAYS backup your system before making changes/modifications.
  51.  
  52. Use at your own risk.
  53.  
  54. I deny liability for the quality of this documentation as well.
  55.  
  56.  
  57. ■ REGISTRATION
  58. --------------
  59.  
  60. With the release of v.40, I did away with the registration system.  It's
  61. completely free.
  62.  
  63. ■ INSTALLATION
  64. --------------
  65.  
  66. Quick rundown for those who know PCBoard well:  Install this PPE in your
  67. CMD.LST (probably want it to be an 'R' replacement).
  68.  
  69. If you need more verbose instructions:
  70.  
  71. I. File Placement/Directory Creation.
  72.    A. Goto your PCBoard directory (usually \PCB)
  73.       1. If you have a directory for all your PPEs, such as \PCB\PPE,
  74.          then goto that.
  75.          a. Make a directory for this PPE.  I recommend \K-READ
  76.       2. If you don't have a PPE directory, just make a directory for
  77.          this.  I suggest \K-READ.
  78.          a. NOTE: Just use \K-READ as your sub-directory name.  It will
  79.             make things a lot easier.
  80.       3. Unzip this archive into your newly created directory.
  81.          a. I assume you've already unzipped the archive, so just move
  82.             all the files into the new directory.
  83.          b. However you do it, make sure all the files get put in the
  84.             \K-READ directory.
  85. II. CMD.LST changes
  86.     A. Load up PCBSetup (you do NOT have to do this for each node)
  87.        1. Caress the 'B' key, then sack the 'B' key again.
  88.        2. Highlight "CMD.LST" and smash the enter/return key.
  89.           a. Now hold down the ALT key, and while holding press the 'I'
  90.              key.
  91.              - oh my!  you've inserted a command!
  92.           b. Edit this newly Inserted command.  99% of the time, you'll
  93.              want to have the command keys as 'R' (no quotes).
  94.              - make sure you provide the full path to this ppe, or
  95.                nothing will happen.  i.e. '\pcb\ppe\K-READ\k-read.ppe'
  96.     B. Pound the Escape key two or three times (God, please let them
  97.        know how to use PCBSetup by now.  Please.  Amen.)
  98.        1. Make sure you save everything.
  99. III. Make sure it works. <G>
  100.      A. Logon to your board, either remotely or locally.
  101.         1. Type 'R' at the main prompt.  If it doesn't work, do some
  102.            trouble shooting.
  103.            a. If you really have problems, leave me mail, and I'll be
  104.               happy to help.  I promise I won't take the same sarcastic
  105.               tone I've taken in writing these docs (seriously, I'm a
  106.               nice guy, I just don't like writing docs).
  107. IV. Customization - SEE SECTION BELOW FOR MORE INFO ON CUSTOMIZATION!
  108.     A. Please do some customizing to this!  It'll look crummy if you
  109.        don't add some type of personal touch!
  110.     B. Edit the K-READ.CFG file.
  111.        1. The K-READ.CFG is really pretty self-eplanitory.  Instructions
  112.           are at the bottom of the file.
  113.     C. Make, buy, or whatever a background screen ('K-READ.').
  114.        1. You CAN have language, graphic, and security specific
  115.           background display files.
  116. V. Notes
  117.    A. What about the 'K-RMNU.*' files?
  118.       1. I added this as an after thought, and do not know if it even
  119.          works.
  120.       2. This is a PCBoard *.MNU (k-rmnu.mnu) and its accompanying
  121.          display file (k-rmnu.).
  122.          a. If all goes to plan, if a user who does not have ansi tries
  123.             to use the PPE, he/she will be taken to this menu instead,
  124.             so that he/she can still have a simplified way to read
  125.             messages.
  126.          b. Again, I never got around to testing this, so it may not
  127.             work.  However, you should use MkPcbMnu to provide a full
  128.             path name to the display file for K-RMNU.MNU.  <shrug>
  129.  
  130.  
  131. ■ HISTORY
  132. ---------
  133.  
  134. Does anybody ever really read the history files for PPEs?  Let's see,
  135. here's some quick info on it:  I wrote it in about 2 hours, worked a few
  136. bugs out, then worked on it for about another hour or two to enhance and
  137. debug it.  I spent tidbits of time here and there erasing bugs, and this
  138. and that with new releases.  I spent about an hour on v.40.
  139.  
  140. v.02 - v.024 ßetas: personal testing stage
  141. v.24 ßeta: first public release
  142. v.28 ßeta: 'QUIT' option added to highlight selector <g>
  143. v.31 ßeta: Tab added as cursor movement key; added code to retain normal
  144.            PCB 'r' options (i.e., if 'R Y A' was typed, K-Read used to load
  145.            up...fixed)
  146. v.40 ßeta: memory requirements lessened; lightbar routines optimized;
  147.            source code reduced by about 1/3; removed registration crap
  148.  
  149.  
  150. ■ CUSTOMIZATION
  151. ---------------
  152.  
  153. With the release of .40, the customization of K-READ is now slightly more
  154. complex.  Realizing this may be a problem for some people, I included some
  155. pre-made config files and background screens, hoping the sysop could find
  156. something that matches his board, and he therefore would not have to mess
  157. around with the config files.
  158.  
  159. First:  two files needed for LIGHTBAR customization:
  160.         K-READ.(no extention)
  161.         K-READ.CFG
  162. note: K-RMNU is the display file for the K-RMNU.MNU file (used when the
  163. caller does not have graphics).  The customization of it should be
  164. self-explanitory).
  165.  
  166. Okay, the K-READ. is the background display file.  This file should include
  167. any designs, pictures, etc, PLUS *ALL* the commands available...NONE of
  168. them should be highlighted.  Note the Row (y position) that the options
  169. begin on.  Once you have the background designed, make sure it is no longer
  170. than 23 lines, or it will scroll up and wierd things will start to happen
  171. (aesthetic problems).  Also, you will probably want to put the AT (@) macro
  172. @poff@ at the start of the background display.  Note, when you actually put
  173. the @poff@, you'll have to use all caps (POFF) or PCBoard will not
  174. recognize it.  This turns off PCBoard's more prompting, so you don't get
  175. 'Press (Enter) to Continue' while your backdrop screen is being displayed.
  176.  
  177. The K-READ.CFG file is slightly more complex (at first).  The first two
  178. lines should ONLY be numbers.  On the second line (starting with second
  179. line because it's easier <g>) you must put the row that the options start
  180. on.  For example, the first option is 'normal pcboard message prompt';
  181. we'll say that the 'n' from 'normal' is at ansi position (27,5).  Thus, you
  182. would enter '5' (without quotes) on the second line of your K-READ.CFG
  183. file.
  184.  
  185. The first line contains the number that represents the LEFT-most X value
  186. for the highlighted text options.  Okay, what this means is this:  say you
  187. have options that are at ansi position (4,15) and (10,16).  For those two
  188. ordered pairs alone, FOUR (4) would be the left-most value.  For the
  189. different reading options in K-READ, you'll have an ordered pair for each
  190. option, thus making 18 ordered pairs, since there are 18 options.  Now,
  191. since K-READ uses the SAME X position for every command, you may have to
  192. include pieces of your background ansi in the config file.  This may not
  193. make sense, but...  I suggest you look over the examples I've provided;
  194. they've all been tested with the PPE and should work for you, plus I tried
  195. to include every possible circumstance for the config files.  They're all
  196. in the file EXAMPLES.ZIP (included in this archive).
  197.  
  198. If you wish to use a background ansi and config file that I've created,
  199. REName your K-READ. file to something like BACK.BA~ and the K-READ.CFG file
  200. to CFG.BA~ (or anything, they are just for backup).  Now ren the BACK?.PCB
  201. of your choice (from the EXAMPLES.ZIP file) to K-READ., and its
  202. corresponding CFG?.PCB to K-READ.CFG. Unfortunately, you can't mix and
  203. match config files and backdrop screens; that would look rediculous.
  204.  
  205. If you can't get a certain background/config setup to work properly, don't
  206. hesitate to contact me, and I'll straighten it out for you.  Note, however,
  207. the only way I will handle such requests is through my BBS.
  208.  
  209.  
  210. ■ REACHING OUT
  211. --------------
  212.  
  213. raw sewage bbs: (309) 389-4754, USR v.Everything
  214.   using my board gets the quickest reply ;)
  215. email: mgarman@heartland.bradley.edu
  216. Salt Air: Matt Garman
  217.